Interface MCU

All Superinterfaces:
Device, IPCObject
All Known Subinterfaces:
MCUComponent, SBC, Thing
All Known Implementing Classes:
MCUComponentImpl, MCUImpl, SBCImpl, ThingImpl

public interface MCU extends Device
Author:
Auto-generated
  • Method Details

    • getDigitalSlotsOffset

      int getDigitalSlotsOffset()
      Information provided by the PKI file:
      
          \class MCU
          
          \brief MCU is the class for a mcu board component, used to make and control things.
          
          \example network().getDevice("MCU0")
          
          \brief Analog and digital slots share the same indexing.  This returns the starting index of the digital slots.
          
          \return int, the starting index of the digital slots.
          
              
      Returns:
      int Returns a int
    • getDigitalSlotsCount

      int getDigitalSlotsCount()
      Information provided by the PKI file:
      
          \brief Returns the number of digital slots.
          
          \return int, the number of digital slots.
          
              
      Returns:
      int Returns a int
    • getAnalogSlotsOffset

      int getAnalogSlotsOffset()
      Information provided by the PKI file:
      
          \brief Analog and digital slots share the same indexing.  This returns the starting index of the analog slots.
          
          \return int, the starting index of the analog slots.
          
              
      Returns:
      int Returns a int
    • getAnalogSlotsCount

      int getAnalogSlotsCount()
      Information provided by the PKI file:
      
          \brief Returns the number of analog slots.
          
          \return int, the number of analog slots.
          
              
      Returns:
      int Returns a int
    • getSlotsCount

      int getSlotsCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of analog and digital slots.
          
          \return int, the total number of analog and digital slots.
          
              
      Returns:
      int Returns a int
    • getComponentAtSlot

      IoEComponent getComponentAtSlot(int slotNum)
      Information provided by the PKI file:
      
          \brief Returns the component at the given slot index.
          
          \param slotNum, slot index to retrive the component from.
          
          \return IoEComponent, the component at the given slot index.  Remember that analog and digital indexes need to be offset with getAnalogSlotsOffset() or getDigitalSlotsOffset().
          
              
      Parameters:
      slotNum - Takes in a parameter of slotNum
      Returns:
      IoEComponent Returns a IoEComponent
    • getComponentByName

      IoEComponent getComponentByName(String slotName)
      Information provided by the PKI file:
      
          \brief Returns the component with the given name.
          
          \param slotName, slot name to retrive the component from.  Something like "D0" or "A1"
          
          \return IoEComponent, the component with the given name.
          
              
      Parameters:
      slotName - Takes in a parameter of slotName
      Returns:
      IoEComponent Returns a IoEComponent
    • digitalWrite

      void digitalWrite(int slotNum, int value)
      Information provided by the PKI file:
      
          \brief Writes a digital signal with the given value to the given slot.
          
          \param slotNum, slot index to write to.
          \param value, value to write.
          
              
      Parameters:
      slotNum - Takes in a parameter of slotNum
      value - Takes in a parameter of value
    • analogWrite

      void analogWrite(int slotNum, int value)
      Information provided by the PKI file:
      
          \brief Writes a analog signal with the given value to the given slot.
          
          \param slotNum, slot index to write to.
          \param value, value to write.
          
              
      Parameters:
      slotNum - Takes in a parameter of slotNum
      value - Takes in a parameter of value
    • addSerialOutputs

      void addSerialOutputs(String output)
      Information provided by the PKI file:
      
          \brief Writes to the mcu output.  Text appears in the MCU output dialog.
          
          \param output, text to write.
          
              
      Parameters:
      output - Takes in a parameter of output
    • getSerialOutputs

      String getSerialOutputs()
      Information provided by the PKI file:
      
          \brief Gets the mcu output.  It is the text that appears in the MCU output dialog.
          
          \return string, value is the text that appears in the MCU output dialog.
          
              
      Returns:
      String Returns a String
    • clearSerialOutputs

      void clearSerialOutputs()
      Information provided by the PKI file:
      
          \brief Clears the MCU output dialog.
          
              
    • setSubComponentIndex

      void setSubComponentIndex(String componentName, int index)
      Information provided by the PKI file:
      
          \brief Sets the current image index of the subcomponent
          
          \arg componentName, name of the component
          \arg index, index to set it to
          
              
      Parameters:
      componentName - Takes in a parameter of componentName
      index - Takes in a parameter of index
    • getSubComponentIndex

      int getSubComponentIndex(String componentName)
      Information provided by the PKI file:
      
          \brief Gets the index of the subcomponent
          
          \arg componentName, name of the component
          
          \return int, index of the component
          
              
      Parameters:
      componentName - Takes in a parameter of componentName
      Returns:
      int Returns a int